Pass builtInOnly parameter correctly for list types
#28
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ruudk
changed the title
builtInOnly parameter correctly for list types
When processing ListOfType in mapGraphQLTypeToPHPType, the $builtInOnly
parameter was incorrectly passed as the second argument ($nullable)
instead of the third argument ($builtInOnly).
This caused the $builtInOnly parameter to default to false when
processing list items, resulting in the PHP mapped type being used
instead of the primitive JSON type in $data parameter docblocks.
Example of the bug:
- GraphQL: currencies: [Currency!]!
- Config: withScalar('Currency', Type::string(), Type::object(Currency::class))
- Generated docblock: 'currencies': list<Currency> (wrong)
- Should be: 'currencies': list<string> (correct)
This caused PHPStan errors like:
"Parameter ruudk#1 $code of class Money\Currency constructor expects
non-empty-string, Money\Currency given."
shahinataei-ts
force-pushed
the
fix/list-scalar-builtin-type-mapping
branch
from
97b518d to
2051fa9
Compare
shahinataei-ts
changed the title
builtInOnly parameter correctly for list types
ruudk
changed the title
builtInOnly parameter correctly for list types Pass builtInOnly parameter correctly for list types
ruudk
changed the title
builtInOnly parameter correctly for list types Pass builtInOnly parameter correctly for list typesbuiltInOnly parameter correctly for list types
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
mapGraphQLTypeToPHPTypeforListOfTypeProblem
When processing
ListOfType, the$builtInOnlyparameter was passed as the second argument ($nullable) instead of the third argument ($builtInOnly):This caused
$builtInOnlyto default tofalse, resulting in the PHP mapped type being used instead of the primitive JSON type in$dataparameter docblocks.Example
PHPStan Error
This bug caused PHPStan errors in generated code:
Affected Types
Any custom scalar where the primitive type differs from the PHP type, when used in a list:
[Currency!]!(string → Money\Currency)[DateTime!]!(string → DateTimeImmutable)[Country!]!(string → Country enum)